Other Constants

Posted by the shared MGLOfflineStorage object when an MGLOfflinePack object’s progress changes. The progress may change due to a resource being downloaded or because the pack discovers during the download that more resources are required for offline viewing. This notification is posted whenever any field in the progress property changes.

The object is the MGLOfflinePack object whose progress changed. The userInfo dictionary contains the pack’s current state in the MGLOfflinePackStateUserInfoKey key and details about the pack’s current progress in the MGLOfflinePackProgressUserInfoKey key. You may also consult the MGLOfflinePack.state and MGLOfflinePack.progress properties, which provide the same values.

If you only need to observe changes in a particular pack’s progress, you can alternatively observe KVO change notifications to the pack’s progress key path.

Posted by the shared MGLOfflineStorage object whenever an MGLOfflinePack object encounters an error while downloading. The error may be recoverable and may not warrant the user’s attention. For example, the pack’s implementation may attempt to re-request failed resources based on an exponential backoff strategy or upon the restoration of network access.

The object is the MGLOfflinePack object that encountered the error. The userInfo dictionary contains the error object in the MGLOfflinePackErrorUserInfoKey key.

Posted by the shared MGLOfflineStorage object when the maximum number of Mapbox-hosted tiles has been downloaded and stored on the current device.

The object is the MGLOfflinePack object that reached the tile limit in the course of downloading. The userInfo dictionary contains the tile limit in the MGLOfflinePackMaximumCountUserInfoKey key.

Once this limit is reached, no instance of MGLOfflinePack can download additional tiles from Mapbox APIs until already downloaded tiles are removed by calling the -[MGLOfflineStorage removePack:withCompletionHandler:] method. Contact your Mapbox sales representative to have the limit raised.

The key for an NSNumber object that indicates an offline pack’s current state. This key is used in the userInfo dictionary of an MGLOfflinePackProgressChangedNotification notification. Call -integerValue on the object to receive the MGLOfflinePackState-typed state.

The key for an NSValue object that indicates an offline pack’s current progress. This key is used in the userInfo dictionary of an MGLOfflinePackProgressChangedNotification notification. Call -MGLOfflinePackProgressValue on the object to receive the MGLOfflinePackProgress-typed progress.

The key for an NSError object that is encountered in the course of downloading an offline pack. This key is used in the userInfo dictionary of an MGLOfflinePackErrorNotification notification. The error’s domain is MGLErrorDomain. See MGLErrorCode for possible error codes.

The key for an NSNumber object that indicates the maximum number of Mapbox-hosted tiles that may be downloaded and stored on the current device. This key is used in the userInfo dictionary of an MGLOfflinePackMaximumMapboxTilesReachedNotification notification. Call -unsignedLongLongValue on the object to receive the uint64_t-typed tile limit.

An NSNumber object containing a floating-point number that specifies the width and height (measured in points) at which the map displays each raster image tile when the map’s zoom level is an integer. The raster source scales its images up or down when the map’s zoom level falls between two integers.

The default value for this option is 512. Version 4 of the Mapbox Maps API requires a value of 256, as do many third-party tile servers, so consult your provider’s documentation for the correct value.

This option is only applicable to MGLRasterSource objects; it is ignored when initializing MGLVectorSource objects.

An NSNumber object containing a Boolean enabling or disabling clustering. If the shape property contains point shapes, setting this option to YES clusters the points by radius into groups. The default value is NO.

This attribute corresponds to the cluster source property in the Mapbox Style Specification.

This option only affects point features within a shape source.

An NSNumber object containing an integer; specifies the radius of each cluster if clustering is enabled. A value of 512 produces a radius equal to the width of a tile. The default value is 50.

An NSNumber object containing an integer; specifies the maximum zoom level at which to cluster points if clustering is enabled. Defaults to one zoom level less than the value of MGLShapeSourceOptionMaximumZoomLevel so that, at the maximum zoom level, the shapes are not clustered.

This attribute corresponds to the clusterMaxZoom source property in the Mapbox Style Specification.

An NSNumber object containing an integer; specifies the maximum zoom level at which to create vector tiles. A greater value produces greater detail at high zoom levels. The default value is 18.

This attribute corresponds to the maxzoom source property in the Mapbox Style Specification.

An NSNumber object containing an integer; specifies the size of the tile buffer on each side. A value of 0 produces no buffer. A value of 512 produces a buffer as wide as the tile itself. Larger values produce fewer rendering artifacts near tile edges and slower performance. The default value is 128.

This attribute corresponds to the buffer source property in the Mapbox Style Specification.

An NSNumber object containing a double; specifies the Douglas-Peucker simplification tolerance. A greater value produces simpler geometries and improves performance. The default value is 0.375.

This attribute corresponds to the tolerance source property in the Mapbox Style Specification.

A version number identifying the default version of the Mapbox Streets style obtained through the -streetsStyleURL method. This version number may also be passed into the -streetsStyleURLWithVersion: method.

The value of this constant generally corresponds to the latest released version as of the date on which this SDK was published. You can use this constant to ascertain the style used by MGLMapView and MGLTilePyramidOfflineRegion when no style URL is specified. Consult the Mapbox Styles API documentation for the most up-to-date style versioning information.

An NSNumber object containing an integer that determines the style function’s exponential interpolation base.

The exponential interpolation base controls the rate at which the function’s output values increase. A value of 1 causes the function to increase linearly based on zoom level or attribute value. A higher exponential interpolation base causes the function’s output values to vary exponentially, increasing more rapidly towards the high end of the function’s range. The default value of this property is 1, for a linear curve.

This attribute corresponds to the base function property in the Mapbox Style Specification.

This option only applies to functions that use an MGLInterpolationModeExponential interpolation mode that are assigned to interpolatable style layer properties.

An MGLConstantStyleValue object that specifies a default value that a style function can use when it can’t otherwise determine a value.

A default value can be used to set the value of a style layer property that is not otherwise set by a function. For example, a source function with a MGLInterpolationModeCategorical interpolation mode with stops that specify color values to use based on a feature’s attributes would set any feature that does not have attributes that match the stop key values to this default value.

This option only applies to MGLSourceStyleFunction and MGLCompositeStyleFunction functions.

An NSNumber object containing an unsigned integer that specifies the minimum zoom level at which to display tiles from the source.

The value should be between 0 and 22, inclusive, and less than MGLTileSourceOptionMaximumZoomLevel, if specified. The default value for this option is 0.

This option corresponds to the minzoom key in the TileJSON specification.

An NSNumber object containing an unsigned integer that specifies the maximum zoom level at which to display tiles from the source.

The value should be between 0 and 22, inclusive, and less than MGLTileSourceOptionMinimumZoomLevel, if specified. The default value for this option is 22.

This option corresponds to the maxzoom key in the TileJSON specification.

An HTML string defining the buttons to be displayed in the map view’s attribution view when the source is part of the map view’s style.

By default, no attribution statements are displayed. If the MGLTileSourceOptionAttributionInfos option is specified, this option is ignored.

This option corresponds to the attribution key in the TileJSON specification.

An array of MGLAttributionInfo objects defining the buttons to be displayed in the map view’s attribution view when the source is part of the map view’s style.

By default, no attribution statements are displayed.

An NSNumber object containing an unsigned integer that specifies the tile coordinate system for the source’s tile URLs. The integer corresponds to one of the constants described in MGLTileCoordinateSystem.

The default value for this option is MGLTileCoordinateSystemXYZ.

This option corresponds to the scheme key in the TileJSON specification.

Indicates an error occurred in the Mapbox SDK.

Project version number for Mapbox.

Project version string for Mapbox.